<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ReadWritableInstant xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/goda/time/ReadWritableInstant.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">/**</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * Defines an instant in the datetime continuum that can be queried and modified.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * This interface expresses the datetime as milliseconds from 1970-01-01T00:00:00Z.</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * The implementation of this interface will be mutable.</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * It may provide more advanced methods than those in the interface.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> *</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> */</em>
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/goda/time/ReadWritableInstant.html">ReadWritableInstant</a> <strong class="jxr_keyword">extends</strong> <a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> {
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>      <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment">     * Sets the value as the number of milliseconds since</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">     * the epoch, 1970-01-01T00:00:00Z.</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">     * </em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">     * @param instant  the milliseconds since 1970-01-01T00:00:00Z to set the</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">     * instant to</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">     */</em>
<a name="38" href="#38">38</a>      <strong class="jxr_keyword">void</strong> setMillis(<strong class="jxr_keyword">long</strong> instant);
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>      <em class="jxr_javadoccomment">/**</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * Sets the millisecond instant of this instant from another.</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     * This method does not change the chronology of this instant, just the</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     * millisecond instant.</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     * </em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * @param instant  the instant to use, null means now</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     */</em>
<a name="48" href="#48">48</a>      <strong class="jxr_keyword">void</strong> setMillis(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <em class="jxr_javadoccomment">/**</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * Sets the chronology of the datetime, which has no effect if not applicable.</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     * </em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * @param chronology  the chronology to use, null means ISOChronology in default zone</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     */</em>
<a name="56" href="#56">56</a>      <strong class="jxr_keyword">void</strong> setChronology(<a href="../../../org/goda/time/Chronology.html">Chronology</a> chronology);
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * Sets the time zone of the datetime, changing the chronology and field values.</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * Changing the zone using this method retains the millisecond instant.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * The millisecond instant is adjusted in the new zone to compensate.</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * </em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     * chronology. Setting the time zone does not affect the millisecond value</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     * of this instant.</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     * If the chronology already has this time zone, no change occurs.</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     *</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * @param zone  the time zone to use, null means default zone</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * @see #setZoneRetainFields</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     */</em>
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">void</strong> setZone(<a href="../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> zone);
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em class="jxr_javadoccomment">/**</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     * Sets the time zone of the datetime, changing the chronology and millisecond.</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * Changing the zone using this method retains the field values.</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * The millisecond instant is adjusted in the new zone to compensate.</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * If the chronology already has this time zone, no change occurs.</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     *</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * @param zone  the time zone to use, null means default zone</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * @see #setZone</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     */</em>
<a name="85" href="#85">85</a>      <strong class="jxr_keyword">void</strong> setZoneRetainFields(<a href="../../../org/goda/time/DateTimeZone.html">DateTimeZone</a> zone);
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="88" href="#88">88</a>      <em class="jxr_javadoccomment">/**</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * Adds a millisecond duration to this instant.</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * This will typically change the value of ost fields.</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     *</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @param duration  the millis to add</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     */</em>
<a name="96" href="#96">96</a>      <strong class="jxr_keyword">void</strong> add(<strong class="jxr_keyword">long</strong> duration);
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * Adds a duration to this instant.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * This will typically change the value of most fields.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     *</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @param duration  the duration to add, null means add zero</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the result exceeds the capacity of the instant</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     */</em>
<a name="106" href="#106">106</a>     <strong class="jxr_keyword">void</strong> add(<a href="../../../org/goda/time/ReadableDuration.html">ReadableDuration</a> duration);
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * Adds a duration to this instant specifying how many times to add.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * This will typically change the value of most fields.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     *</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @param duration  the duration to add, null means add zero</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * @param scalar  direction and amount to add, which may be negative</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the result exceeds the capacity of the instant</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     */</em>
<a name="117" href="#117">117</a>     <strong class="jxr_keyword">void</strong> add(<a href="../../../org/goda/time/ReadableDuration.html">ReadableDuration</a> duration, <strong class="jxr_keyword">int</strong> scalar);
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em class="jxr_javadoccomment">/**</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * Adds a period to this instant.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * This will typically change the value of most fields.</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     *</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @param period  the period to add, null means add zero</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the result exceeds the capacity of the instant</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">void</strong> add(<a href="../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period);
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>     <em class="jxr_javadoccomment">/**</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * Adds a period to this instant specifying how many times to add.</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * This will typically change the value of most fields.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @param period  the period to add, null means add zero</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * @param scalar  direction and amount to add, which may be negative</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the result exceeds the capacity of the instant</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     */</em>
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">void</strong> add(<a href="../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period, <strong class="jxr_keyword">int</strong> scalar);
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="141" href="#141">141</a>     <em class="jxr_javadoccomment">/**</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * Sets the value of one of the fields of the instant, such as hourOfDay.</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     *</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @param type  a field type, usually obtained from DateTimeFieldType, null ignored</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * @param value  the value to set the field to</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the value is invalid</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     */</em>
<a name="148" href="#148">148</a>     <strong class="jxr_keyword">void</strong> set(<a href="../../../org/goda/time/DateTimeFieldType.html">DateTimeFieldType</a> type, <strong class="jxr_keyword">int</strong> value);
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>     <em class="jxr_javadoccomment">/**</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * Adds to the instant specifying the duration and multiple to add.</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     *</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * @param type  a field type, usually obtained from DateTimeFieldType, null ignored</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * @param amount  the amount to add of this duration</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the result exceeds the capacity of the instant</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     */</em>
<a name="157" href="#157">157</a>     <strong class="jxr_keyword">void</strong> add(<a href="../../../org/goda/time/DurationFieldType.html">DurationFieldType</a> type, <strong class="jxr_keyword">int</strong> amount);
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

